sycommon.h

Go to the documentation of this file.

/*********************************************************************
 *
 *           Copyright (c) 2021 by Visuality Systems, Ltd.
 *
 *************************************************************************
 * FILE NAME     : $Workfile:$
 * ID            : $Header:$
 * REVISION      : $Revision:$
 *--------------------------------------------------------------------
 * DESCRIPTION   : System common API
 *--------------------------------------------------------------------
 * MODULE        : NQ
 * DEPENDENCIES  :
 *************************************************************************/

#ifndef _SYCOMMON_H_
#define _SYCOMMON_H_

typedef struct
{
    NQ_TIME creationTime;           
    NQ_TIME lastChangeTime;         
    NQ_TIME lastAccessTime;         
    NQ_TIME lastWriteTime;          
    NQ_UINT32 sizeLow;              
    NQ_UINT32 sizeHigh;             
    NQ_UINT32 allocSizeLow;         
    NQ_UINT32 allocSizeHigh;        
    NQ_UINT32 attributes;           
    NQ_UINT32 isDeleted;            
    NQ_UINT32 numLinks;             
    NQ_UINT32 fileIdLow;            
    NQ_UINT32 fileIdHigh;           
} SYFileInformation;

#define SY_ATTR_READONLY            0x001 
#define SY_ATTR_HIDDEN              0x002 
#define SY_ATTR_SYSTEM              0x004 
#define SY_ATTR_VOLUME              0x008 
#define SY_ATTR_DIRECTORY           0x010 
#define SY_ATTR_ARCHIVE             0x020 
#define SY_ATTR_DEVICE              0x040 
#define SY_ATTR_NORMAL              0x080 
#define SY_ATTR_TEMPORARY           0x100 
#define SY_ATTR_SPARSE_FILE         0x200 
#define SY_ATTR_REPARSE_POINT       0x400 
#define SY_ATTR_COMPRESSED          0x800 
#define SY_ATTR_OFFLINE             0x1000 
#define SY_ATTR_NOT_CONTENT_INDEXED 0x2000 
#define SY_ATTR_ENCRYPTED           0x4000 
typedef struct
{
    NQ_UINT32 serialNumberLow;                
    NQ_UINT32 serialNumberHigh;               
    NQ_UINT32 creationTimeLow;                
    NQ_UINT32 creationTimeHigh;               
    NQ_UINT32 fileSystemIdLow;                
    NQ_UINT32 fileSystemIdHigh;               
    NQ_UINT32 blockSizeLow;                   
    NQ_UINT32 blockSizeHigh;                  
    NQ_UINT32 blocksPerUnitLow;               
    NQ_UINT32 blocksPerUnitHigh;              
    NQ_UINT32 totalUnitsLow;                  
    NQ_UINT32 totalUnitsHigh;                 
    NQ_UINT32 freeUnitsLow;                   
    NQ_UINT32 freeUnitsHigh;                  
} SYVolumeInformation;


typedef struct
{
    NQ_UINT16 sec;      
    NQ_UINT16 min;      
    NQ_UINT16 hour;     
    NQ_UINT16 day;      
    NQ_UINT16 month;    
    NQ_UINT16 year;     
} SYTimeFragments;

typedef struct
{
    NQ_UINT16 specVersion;
    NQ_UINT16 driverVersion;
    NQ_UINT16 size;
    NQ_UINT16 driverExtraLength;
    const NQ_BYTE* driverExtraData;
    NQ_UINT32 fields;
    NQ_UINT16 orientation;
    NQ_UINT16 paperSize;
    NQ_UINT16 paperLength;
    NQ_UINT16 paperWidth;
    NQ_UINT16 scale;
    NQ_UINT16 copies;
    NQ_UINT16 defaultSource;
    NQ_UINT16 printQuality;
    NQ_UINT16 color;
    NQ_UINT16 duplex;
    NQ_UINT16 yResolution;
    NQ_UINT16 ttOption;
    NQ_UINT16 collate;
    const NQ_WCHAR* formName;
    NQ_UINT16 logPixels;
    NQ_UINT32 bitsPerPel;
    NQ_UINT32 pelsWidth;
    NQ_UINT32 pelsHeight;
    NQ_UINT32 displayFlags;
    NQ_UINT32 displayFrequency;
    NQ_UINT32 icmMethod;
    NQ_UINT32 icmIntent;
    NQ_UINT32 mediaType;
    NQ_UINT32 ditherType;
    NQ_UINT32 reserved1;
    NQ_UINT32 reserved2;
    NQ_UINT32 panningWidth;
    NQ_UINT32 panningHeight;
} SYDeviceMode;


#define SY_PRINTEROSVERSION_WIN 3

typedef struct
{
    NQ_UINT32 osVersion;
    const NQ_WCHAR* name;
    const NQ_WCHAR* driverPath;
    const NQ_WCHAR* dataFile;
    const NQ_WCHAR* configFile;
    const NQ_WCHAR* helpFile;
    const NQ_WCHAR** dependentFiles;
    const NQ_WCHAR* monitorName;
    const NQ_WCHAR* defaultDataType;
    const NQ_WCHAR** previousNames;
    NQ_UINT32 driverDate;
    NQ_UINT32 driverVersions[2];
    const NQ_WCHAR* manufacturer;
    const NQ_WCHAR* manufacturerURL;
    const NQ_WCHAR* hardwareID;
    const NQ_WCHAR* provider;
    NQ_UINT32 attributes;
    NQ_UINT32 configVersion;
    NQ_UINT32 driverVersion;
} SYPrinterDriver;

#define SY_DEVICEMODE_ORIENTATION       0x00000001
#define SY_DEVICEMODE_PAPERSIZE         0x00000002
#define SY_DEVICEMODE_PAPERLENGTH       0x00000004
#define SY_DEVICEMODE_PAPERWIDTH        0x00000008
#define SY_DEVICEMODE_SCALE             0x00000010
#define SY_DEVICEMODE_POSITION          0x00000020
#define SY_DEVICEMODE_NUP               0x00000040
#define SY_DEVICEMODE_COPIES            0x00000080
#define SY_DEVICEMODE_DEFAULTSOURCE     0x00000100
#define SY_DEVICEMODE_PRINTQUALITY      0x00000400
#define SY_DEVICEMODE_COLOR             0x00000800
#define SY_DEVICEMODE_DUPLEX            0x00001000
#define SY_DEVICEMODE_YRESOLUTION       0x00002000
#define SY_DEVICEMODE_TTOPTION          0x00004000
#define SY_DEVICEMODE_COLLATE           0x00008000
#define SY_DEVICEMODE_FORMNAME          0x00010000
#define SY_DEVICEMODE_LOGPIXELS         0x00020000
#define SY_DEVICEMODE_BITSPERPEL        0x00040000
#define SY_DEVICEMODE_PELWIDTH          0x00080000
#define SY_DEVICEMODE_PELHEIGHT         0x00100000
#define SY_DEVICEMODE_DISPLAYFLAGS      0x00200000
#define SY_DEVICEMODE_DISPLAYFREQUENCY  0x00400000
#define SY_DEVICEMODE_ICMMETHOD         0x00800000
#define SY_DEVICEMODE_ICMINTENT         0x01000000
#define SY_DEVICEMODE_MEDIATYPE         0x02000000
#define SY_DEVICEMODE_DITHERTYPE        0x04000000
#define SY_DEVICEMODE_PANNINGWIDTH      0x08000000
#define SY_DEVICEMODE_PANNINGHEIGHT     0x10000000

typedef struct
{
    NQ_UINT32 flags;                
    NQ_WCHAR* portName;
    NQ_WCHAR* driverName;
    NQ_WCHAR* comment;
    NQ_WCHAR* location;
    SYDeviceMode devMode;
    NQ_WCHAR* sepFile;
    NQ_WCHAR* printProcessor;
    NQ_WCHAR* dataType;
    NQ_WCHAR* parameters;
    NQ_UINT32 attributes;
    NQ_UINT32 priority;
    NQ_UINT32 defaultPriority;
    NQ_UINT32 startTime;
    NQ_UINT32 untilTime;
    NQ_UINT32 status;
    NQ_UINT32 cJobs;
    NQ_UINT32 totalJobs;
    NQ_UINT32 totalBytes;
    NQ_UINT32 globalCounter;
    NQ_UINT32 totalPages;
    NQ_UINT16 majorVersion;
    NQ_UINT16 buildVersion;
    NQ_UINT32 sessionCounter;
    NQ_UINT32 printerErrors;
    NQ_UINT32 cSetPrinter;
    NQ_UINT32 averagePpm;
    NQ_UINT32 deviceNotSelectedTimeout;
    NQ_UINT32 transmissionRetryTimeout;
    NQ_BYTE* securityDescriptor;
    NQ_UINT32 securityDescriptorLength;
}
SYPrinterInfo;

#define SY_PRINTERSTATUS_PAUSED             0x00000001
#define SY_PRINTERSTATUS_ERROR              0x00000002
#define SY_PRINTERSTATUS_PENDINGDELETION    0x00000004
#define SY_PRINTERSTATUS_PAPERJAM           0x00000008
#define SY_PRINTERSTATUS_PAPEROUT           0x00000010
#define SY_PRINTERSTATUS_MANUALFEED         0x00000020
#define SY_PRINTERSTATUS_PAPERPROBLEM       0x00000040
#define SY_PRINTERSTATUS_OFFLINE            0x00000080
#define SY_PRINTERSTATUS_IOACTIVE           0x00000100
#define SY_PRINTERSTATUS_BUSY               0x00000200
#define SY_PRINTERSTATUS_PRINTING           0x00000400
#define SY_PRINTERSTATUS_OUTPUTBINFULL      0x00000800
#define SY_PRINTERSTATUS_NOTAVAILABLE       0x00001000
#define SY_PRINTERSTATUS_WAITING            0x00002000
#define SY_PRINTERSTATUS_PROCESSING         0x00004000
#define SY_PRINTERSTATUS_INITIALIZING       0x00008000
#define SY_PRINTERSTATUS_WARMINGUP          0x00010000
#define SY_PRINTERSTATUS_TONERLOW           0x00020000
#define SY_PRINTERSTATUS_NOTONER            0x00040000
#define SY_PRINTERSTATUS_PAGEPUNT           0x00080000
#define SY_PRINTERSTATUS_USERINTERVENTION   0x00100000
#define SY_PRINTERSTATUS_OUTOFMEMORY        0x00200000
#define SY_PRINTERSTATUS_DOOROPEN           0x00400000
#define SY_PRINTERSTATUS_SERVERUNKNOWN      0x00800000
#define SY_PRINTERSTATUS_POWERSAVE          0x01000000

#define SY_PRINTERATTR_QUEUED       0x0001   
#define SY_PRINTERATTR_DIRECT       0x0002   
#define SY_PRINTERATTR_DEFAULT      0x0004   
#define SY_PRINTERATTR_SHARED       0x0008   
#define SY_PRINTERATTR_NETWORK      0x0010   
#define SY_PRINTERATTR_RESERVED     0x0020   /* */
#define SY_PRINTERATTR_LOCAL        0x0040   
#define SY_PRINTERATTR_DEVQUERY     0x0080   
#define SY_PRINTERATTR_KEEPJOBS     0x0100   
#define SY_PRINTERATTR_LIFO         0x0200   
#define SY_PRINTERATTR_OFFLINE      0x0400   
#define SY_PRINTERATTR_BIDI         0x0800   
#define SY_PRINTERATTR_RAWONLY      0x1000   
#define SY_PRINTERATTR_PUBLISHED    0x2000   
#define SY_PRINTERATTR_EXPAND       0x4000
#define SY_PRINTERATTR_CONTAINER    0x8000
#define SY_PRINTERATTR_ICON1        0x10000
#define SY_PRINTERATTR_ICON2        0x20000
#define SY_PRINTERATTR_ICON3        0x40000
#define SY_PRINTERATTR_ICON4        0x80000
#define SY_PRINTERATTR_ICON5        0x100000
#define SY_PRINTERATTR_ICON6        0x200000
#define SY_PRINTERATTR_ICON7        0x400000
#define SY_PRINTERATTR_ICON8        0x800000

typedef struct
{
    NQ_UINT32 id;                   
    const NQ_WCHAR* documentName;   
    const NQ_WCHAR* pStatus;        
    NQ_UINT32 status;               
    NQ_UINT32 priority;             
    NQ_UINT32 position;             
    NQ_UINT32 totalPages;           
    NQ_UINT32 pagesPrinted;         
    NQ_UINT32 submitTime;           
    NQ_UINT32 startTime;            
    NQ_UINT32 untilTime;            
    NQ_UINT32 time;                 
    NQ_UINT32 size;                 
    NQ_BYTE* securityDescriptor;           
    NQ_UINT32 securityDescriptorLength;    
    const void* user;               
}
SYPrintJobInfo;

#define SY_PRINTJOBSTATUS_PAUSED           0x00000001 
#define SY_PRINTJOBSTATUS_ERROR            0x00000002 
#define SY_PRINTJOBSTATUS_DELETING         0x00000004 
#define SY_PRINTJOBSTATUS_SPOOLING         0x00000008 
#define SY_PRINTJOBSTATUS_PRINTING         0x00000010 
#define SY_PRINTJOBSTATUS_OFFLINE          0x00000020 
#define SY_PRINTJOBSTATUS_PAPERPROBLEM     0x00000040 
#define SY_PRINTJOBSTATUS_PRINTED          0x00000080 
#define SY_PRINTJOBSTATUS_DELETED          0x00000100 
#define SY_PRINTJOBSTATUS_BLOCKED          0x00000200 
#define SY_PRINTJOBSTATUS_USERINTERVENTION 0x00000400 
#define SY_PRINTJOBSTATUS_RESTART          0x00000800 
#define SY_PRINTJOB_MINPRIORITY     1   
#define SY_PRINTJOB_MAXPRIORITY     99  
#define SY_PRINTJOB_DEFPRIORITY     1   
#define SY_PRINTERCONTROL_PAUSE         1   
#define SY_PRINTERCONTROL_RESUME        2   
#define SY_PRINTERCONTROL_PURGE         3   
#define SY_PRINTERCONTROL_SETSTATUS     4   
#define SY_PRINTJOBCOM_PAUSE            1   
#define SY_PRINTJOBCOM_RESUME           2   
#define SY_PRINTJOBCOM_CANCEL           3   
#define SY_PRINTJOBCOM_RESTART          4   
#define SY_PRINTJOBCOM_DELETE           5   
#define SY_PRINTJOBCOM_SENDTOPRINTER    6   
#define SY_PRINTJOBCOM_LASTPAGEEJECTED  7   
typedef struct
{
    NQ_UINT32 width;            
    NQ_UINT32 height;           
}
SYPrintSize;

typedef struct
{
    NQ_UINT32 left;             
    NQ_UINT32 top;              
    NQ_UINT32 right;            
    NQ_UINT32 bottom;           
}
SYPrintRect;

typedef struct
{
    NQ_UINT32 id;                       
    const NQ_WCHAR* name;               
    NQ_UINT32 flags;                    
    SYPrintSize size;                   
    SYPrintRect imageableArea;          
}
SYPrintFormInfo;

#define SY_PRINTFORMFLAG_USER       0x00000000  
#define SY_PRINTFORMFLAG_BUILTIN    0x00000001  
#define SY_PRINTFORMFLAG_PRINTER    0x00000002  
#endif  /* _SYCOMMON_H_ */